/*
 * Copyright (c) 2011-2012 Alexander Dubu
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * o  Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * o  Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * o  Neither the name Axil nor the names of its contributors may be used to
 *    endorse or promote products derived from this software without specific
 *    prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package axil.framework.localization;

import axil.etc.Identity;
import axil.etc.Immutable;
import axil.framework.collection.IdentityMap;
import axil.framework.config.Configuration;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

import static axil.framework.Functions.immute;


/**
 * The Axil definition of a country.
 */
public class Country implements Identity, Immutable {
	private static final List<Country> countries = load();
	private static final IdentityMap<Country> index =
	    new IdentityMap<Country>(countries);

	private final String ident;		// ISO 3166-1 country code (e.g., "US")
	private final String local;		// Name of this country in dominant lang
	private final String english;	// Name of this country, in English
	private final Language language;// ISO 639-1 primary language (e.g. "en")
	private final String currency;	// ISO 4177 currency code (e.g., "USD")


	private Country(Configuration cfg) {
		this.ident = cfg.text("country-code");
		this.local = cfg.text("local-name");
		this.english = cfg.text("english-name");
		this.language = Language.from(cfg.text("primary-language"));
		this.currency = cfg.text("currency");
	}


	private static List<Country> load() {
		List<Country> list = new ArrayList<Country>();
		List<String> names = Configuration.axil().list("supported-countries");
		for (String name : names) {
			list.add(new Country(new Configuration("data/country/" + name + ".cfg")));
		}
		return list;
	}


	/**
	 * Get the unique identity for this object. The value returned is the
	 * ISO 3166 country code.
	 */
	public String identity() {
		return ident;
	}


	/**
	 * The name of this country is the primary language of that country.
	 */
	public String local() {
		return local;
	}


	/**
	 * The name of the country in US English.
	 */
	public String english() {
		return english;
	}


	public Language language() {
		return language;
	}


	public String currency() {
		return currency;
	}


	public static Country from(String ident) {
		return index.at(ident);
	}


	public static Collection<Country> all() {
		return immute(countries);
	}
}
